home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d8 / pcpm200.arc / PCPMENU.DOC < prev    next >
Text File  |  1990-12-27  |  13KB  |  343 lines
  1.  
  2.  
  3.  
  4.      ████▄  ▄████  ████▄  ██▄ ▄██
  5.      ██ ██  ██     ██ ██  ██▀█▀██
  6.      ████▀  ██     ████▀  ██   ██  ▄▄▄  ▄  ▄  ▄ ▄
  7.      ██     ██     ██     ██   ██  █▄   █▀▄█  █ █
  8.      ██     ▀████  ██     ██   ██  █▄▄  █  █  █▄█
  9.  
  10.      Copyright 1990, 1991 - Tony Shelton
  11.  
  12.                 An External Protocol Handler for your Comm Package!
  13.  
  14.         P C P M E N U
  15.  
  16.  
  17.  
  18.  
  19.  
  20. DESCRIPTION:
  21.  
  22.         This documentation has been divided into several sections which will
  23.         demonstrate how to install and run this handy "add-in" to your
  24.         communications package.
  25.  
  26.     This program was born out of the need to add support for the
  27.         many protocols supported by the Digital X-Connect RyBBS.  It was
  28.     written primarily for Procomm Plus, but there is no reason it
  29.         can't be used by other telecommunications programs that allow
  30.     the execution of external programs while on-line.
  31.  
  32.  
  33.  
  34.                 There, got that out of the way.
  35.  
  36. INSTALLATION:
  37.  
  38.     This program is purposely small and does a minimum of
  39.         fireworks outside of its intended purpose.
  40.  
  41.         It occupies only about 12.5K of RAM.  It does have the ability to
  42.         shell to DOS, which might be handy to those whose modem software
  43.         does not support such a feature.
  44.  
  45.  
  46.  
  47.     Setting up PCPMENU - four basic steps!
  48.  
  49.         Setting up the program requires three basic steps:
  50.  
  51.          1.  Placing a copy of all the files included in your
  52.              PCPMxxx.ZIP disk in the same directory as your communications
  53.              application program (I use the same directory where Procomm is).
  54.  
  55.          2.  Included in the ZIP is a file called FILES.DAT which
  56.              contains a sample set of the information needed to execute the
  57.              external protocols from PCPMenu.  This file structure is
  58.              simple and instructions for editing are shown later in this
  59.              document.
  60.  
  61.              The second step is to convert this file to a form which
  62.              PCPMenu can use.
  63.  
  64.          3.  Invoking a Procomm (or other application) HOT KEY to call the
  65.              utility on a single keystroke.
  66.               
  67.     And that will do it!  Below is a step by step process to accomplish
  68.     this and start your way to using this handy program.
  69.  
  70.         STEP 1:  Number one should be self explanatory.  Simply unzip the
  71.                  PCPM???.ZIP file using PKUNZIP (this version utilizes
  72.                  version 1.10) into your Procomm Plus or other
  73.                  communications application directory.
  74.  
  75.                  Command example: (assuming C:\PCPLUS\ is dir.)
  76.  
  77.                  C:\>PKUNZIP PCPM???.ZIP C:\PCPLUS
  78.  
  79.                  Results:  PKUNZIP will explode the PCPM???.ZIP file into
  80.                  five (5) files listed below:
  81.  
  82.                  PCPMENU.EXE   ------------ the program
  83.                  CONVERT.EXE   ------------ conversion utility
  84.                  FILES.DAT     ------------ example protocol data file
  85.                  PCPMENU.DOC   ------------ this file
  86.                  REGISTER.DOC  ------------ information on registering
  87.                                             PCPMENU
  88.  
  89.  
  90.         STEP 2:  For number two, you need a pure ASCII text editor such as
  91.                  Qedit, EDLIN or use the ASCII capability in your Word
  92.                  Processor.  Edit the file FILES.DAT which was created after
  93.                  you unzipped PCPM???.ZIP.
  94.  
  95.                  There are two methods of using PCPMENU depending on your
  96.                  preference of managing your external protocols.  The
  97.                  first is to invoke a batch file (usually provided with
  98.                  the external protocol by it's author):
  99.  
  100.                  Your file should look something like this (without the
  101.                  comments):
  102.  
  103.                  a                         {character to pick off of the menu}
  104.                  Lynx Upload               {description}
  105.                  c:\modem                  {directory to find the file}
  106.                  lynxup.bat                {batch file to execute}
  107.                  #?                        {explained below}
  108.                  b
  109.                  Lynx Download
  110.                  c:\modem
  111.                  lynxdn.bat
  112.                  #
  113.  
  114.                  The last item for each entry is the command line parameter,
  115.                  or it is a switch used internally by PCPMENU.  These are
  116.                  described as follows:
  117.  
  118.         # - means execute a batch file.  This signals PCPMENU to
  119.             execute the file through the command interpreter i.e.
  120.             COMMAND.COM.
  121.  
  122.        #? - means execute a batch file and prompt the user for an
  123.             additional command line parameters to be fed to the
  124.             called program.
  125.  
  126.         ? - means you are executing a .COM or .EXE file and you wish
  127.             to pass a command line to it.
  128.  
  129.                  Or, you can just leave that line blank and the program (.COM
  130.                  or .EXE file only) will execute without a command line.  But,
  131.                  that line MUST be there.
  132.  
  133.                  The second method to utilize FILES.DAT is to place the
  134.                  protocol execution command right in FILES.DAT instead of
  135.                  a batch file.  The command line data can be put directly
  136.                  into the FILES.DAT (see accompanying file; modify it to
  137.                  suit your directory structure.)
  138.  
  139.                  Look at the example above and compare it with the following:
  140.  
  141.                  a
  142.                  Lynx Upload
  143.                  c:\modem
  144.                  lynx.exe
  145.                  S /B /S ?
  146.  
  147.                  -------|  the space is needed between the "/S" and the "?".
  148.                  The ?-mark tells PCPMENU that more input is needed (in this
  149.                  case, the file to be uploaded.)  Thus, no more batch files
  150.                  are needed!
  151.  
  152.                  Either way of implementing the FILES.DAT will work.
  153.  
  154.                  You will find that the FILES.DAT included with this
  155.                  release is in the second of the two formats!
  156.  
  157.  
  158.     STEP 3:  The next step is to convert the FILES.DAT to a useable
  159.                  format by PCPMENU.
  160.  
  161.     Having finished creating FILES.DAT run CONVERT.EXE.  It will
  162.     take that plain ASCII text file and convert it to a format
  163.     that can be used by PCPMENU and place it in a file called
  164.     FILESREC.DAT.
  165.  
  166.     The FILES.DAT file is not deleted so you can make additions and
  167.     deletions as you desire, just edit the file and re-run CONVERT.
  168.     When you rerun CONVERT, it will automatically delete the old
  169.     FILESREC.DAT and replace it with the newly created file.
  170.  
  171.  
  172.                 The command should be issued as follows:
  173.  
  174.                 C:\PCPLUS\> CONVERT [n]
  175.  
  176.         There are three options for [n] above.  They are:
  177.  
  178.                 1: Convert FILES.DAT to FILESREC.DAT
  179.                 2: Convert FILESREC.DAT to FILES.DAT
  180.                 3: Reorder the command characters
  181.  
  182.         If you enter CONVERT [return] (with no number), the convert
  183.         program will output the proper syntax requirements and options.
  184.  
  185.  
  186.     STEP 4:  Finally, install PCPMENU as a hot-key callable file in your
  187.                  software (in Procomm - Alt-J or Alt-U).
  188.  
  189.         This is done in Procomm by choosing the ALT-S, set-up, key and
  190.         moving the cursor to FILE\PATH OPTIONS and hitting <enter>.  The
  191.         two bottom options will allow you to enter program names into
  192.         the ALT-J and ALT-U hot keys.  Simply enter PCPMENU.EXE into one
  193.         of them.
  194.  
  195.         Be sure to save the set-up when finished!
  196.  
  197.         You can now verify PCPMENU is operational by hitting the ALT-J
  198.         or ALT-U hot key.  The PCPMENU screen will appear.
  199.         Congratulations!  You now have a full and complete external
  200.         protocol interface ready to save you time and money!
  201.  
  202.  
  203. OPERATING PCPMenu:
  204.  
  205.         Operation of PCPMenu is simple: when you are ready to transfer a
  206.         file from the bulletin board and the board prompts you to begin the
  207.         transfer, simply use either the hotkey command, Alt-J or Alt-U,
  208.         or drop to DOS and execute PCPmenu.
  209.  
  210.         A menu (which you essentially provided the data for in
  211.         FILES.DAT) will pop up on your screen.  The Menu will look like
  212.         this:
  213. ------------------------------------------------------------------------
  214.                                 PROTOCOL MENU
  215.                                    Page: 1
  216.  
  217.  
  218.                 a - Lynx Download
  219.                 b - Zmodem Download
  220.                 c - T-Modem Download
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.                 1 - Shell to DOS        Beep ON         q - Quit
  230.                                Enter Your Choice:
  231.                    SPACE - Toggle Beep              ESC- Swap Pages
  232. -----------------------------------------------------------------------
  233.  
  234.  
  235.         Just key in the letter corresponding to the protocol desired and
  236.         PCPMenu will execute the batch file or command line for the
  237.         protocol you placed in that assigned letter.
  238.  
  239.         Also from the PCPMenu screen you can Drop To DOS by typing a
  240.         "1".  This operates like any drop to DOS and will allow you to
  241.         edit FILES.DAT as you learn to utilize new protocols etc.
  242.  
  243.         The Space Bar will toggle the PCPmenu "Beep" which alerts you
  244.         when uploading or downloading is complete.  This is handy for
  245.         extended file transfers.  The status of the "beep" switch is
  246.         shown as Beep ON or Beep OFF.
  247.  
  248.         "Q" will quit the PCPmenu screen and return you to your
  249.         communications package, or to DOS depending on where you
  250.         executed the program from.
  251.  
  252.         The ESCape key allows you to switch pages in a cyclical fashion.
  253.         For those of you wanting to set up a variety of external options,
  254.         PCPMenu is perfect.  Up to 256 pages of 38 external protocols can
  255.         be installed in FILES.DAT!!!!
  256.  
  257.         Obviously, this is excessive, but there is a reason.  You can
  258.         force a page break by inserting "|" character in FILES.DAT.
  259.         I suggest you use a bunch on one line just for clarity.  This
  260.         is illustrated in the sample FILES.DAT.
  261.  
  262.         This feature is handy should you want to segregate your protocols,
  263.         i.e.  put all DSZ-driven protocols on a seperate page.
  264.  
  265.         Legal stuff:
  266.         PCPMENU is being offered as shareware.  That means if you use it,
  267.         you should pay for it.
  268.  
  269.  
  270.         Revision History:
  271.  
  272.         *********************************************************************
  273.  
  274.         New features:  (2/10/90)
  275.  
  276.     For those protocols that do not have an "alert" beeper to signal
  277.     when a transfer is completed, or the program has aborted; I have
  278.     added a BEEP toggle.  Pressing the spacebar toggles the beep on
  279.     and off.
  280.  
  281.     *********************************************************************
  282.  
  283.     New features:  (3/3/90)
  284.  
  285.     Made a few code changes to reduce the amount of memory taken
  286.     by the program.  Added the ability to have a command line
  287.     of up to 80 characters instead of 25.  This became a necessity
  288.     with batch uploads that had many long paths.
  289.  
  290.         *********************************************************************
  291.  
  292.         Fix:  (4/8/90)
  293.  
  294.         I found that I was allocating 80 bytes to each element of an
  295.         array when I only needed 20.  This saves about 3-4K
  296.  
  297.         *********************************************************************
  298.  
  299.         New features:  (5/12/90)
  300.  
  301.         CONVERT now does three things:
  302.         1.  converts FILES.DAT to FILESREC.DAT (original function).
  303.         2.  converts FILESREC.DAT back to FILES.DAT, this is for those
  304.             that use the ADDP and DELP programs.
  305.         3.  re-orders the command characters should you do a lot of
  306.             rearranging, adding, and deleting of protocols.
  307.  
  308.         *********************************************************************
  309.  
  310.         Fix:  (7/1/90)
  311.  
  312.         I discovered that I was using a reserved word for a variable.
  313.         The compiler didn't catch it, and there were no problems that
  314.         I found.  But, better safe than sorry!
  315.  
  316.         *********************************************************************
  317.  
  318.         New feature:  (10/7/90)
  319.  
  320.         Batch files are now a thing of the past.  Added a parsing routine
  321.         needed to do away with batch files where additional information is
  322.         needed to be passed to the command line.
  323.  
  324.         *********************************************************************
  325.  
  326.         New features (12/19/90)  v2.00
  327.  
  328.         Added the ability to handle multiple pages of protocols.
  329.  
  330.     *********************************************************************
  331.     If you have any questions or find a bug, you can contact me on
  332.         The Digital X-Connect BBS, 214/517-8443, or at my Compuserve
  333.     address 75156,3233.
  334.  
  335.         Credit goes to Dave Stoops and Andy Walding for making this
  336.         document understandable by humans, and to Andy Walding,
  337.         Sysop of the Digital X-Connect for proof-reading and formatting
  338.         it nicely.  Any errors in it are my own.
  339.  
  340.     I hope you find this program a handy tool in your BBS'ing.
  341.     
  342.     Tony Shelton
  343.